<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>esapi.codecs.ldap_dn</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="esapi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="esapi-module.html">Package&nbsp;esapi</a> ::
        <a href="esapi.codecs-module.html">Package&nbsp;codecs</a> ::
        Module&nbsp;ldap_dn
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="esapi.codecs.ldap_dn-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="esapi.codecs.ldap_dn-module.html">Module esapi.codecs.ldap_dn</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/python</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment"># -*- coding: utf-8 -*-</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">@license: OWASP Enterprise Security API (ESAPI)</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-docstring">    This file is part of the Open Web Application Security Project (OWASP)</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-docstring">    Enterprise Security API (ESAPI) project. For details, please see</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-docstring">    U{http://www.owasp.org/index.php/ESAPI&lt;http://www.owasp.org/index.php/ESAPI&gt;}.</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">    The ESAPI is published by OWASP under the BSD license. You should read and </tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">    accept the LICENSE before you use, modify, and/or redistribute this software.</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring">@summary: Implementation of the Codec interface for LDAP distinguished name </tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">    encoding.</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">@copyright: Copyright (c) 2009 - The OWASP Foundation</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-docstring">@author: Craig Younkins (craig.younkins@owasp.org)</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Package esapi=esapi-module.html"><a title="esapi" class="py-name" href="#" onclick="return doclink('link-0', 'esapi', 'link-0');">esapi</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package esapi.codecs=esapi.codecs-module.html"><a title="esapi.codecs" class="py-name" href="#" onclick="return doclink('link-1', 'codecs', 'link-1');">codecs</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module esapi.codecs.codec=esapi.codecs.codec-module.html"><a title="esapi.codecs.codec" class="py-name" href="#" onclick="return doclink('link-2', 'codec', 'link-2');">codec</a></tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="esapi" class="py-name" href="#" onclick="return doclink('link-3', 'esapi', 'link-0');">esapi</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="esapi.codecs" class="py-name" href="#" onclick="return doclink('link-4', 'codecs', 'link-1');">codecs</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="esapi.codecs.codec" class="py-name" href="#" onclick="return doclink('link-5', 'codec', 'link-2');">codec</a></tt> <tt class="py-keyword">import</tt> <tt id="link-6" class="py-name" targets="Class esapi.codecs.codec.Codec=esapi.codecs.codec.Codec-class.html"><a title="esapi.codecs.codec.Codec" class="py-name" href="#" onclick="return doclink('link-6', 'Codec', 'link-6');">Codec</a></tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"> </tt>
<a name="LDAPDNCodec"></a><div id="LDAPDNCodec-def"><a name="L23"></a><tt class="py-lineno">23</tt> <a class="py-toggle" href="#" id="LDAPDNCodec-toggle" onclick="return toggle('LDAPDNCodec');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="esapi.codecs.ldap_dn.LDAPDNCodec-class.html">LDAPDNCodec</a><tt class="py-op">(</tt><tt class="py-base-class">Codec</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LDAPDNCodec-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="LDAPDNCodec-expanded"><a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt class="py-docstring">    Implementation of the Codec interface for LDAP distinguished name encoding.</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line">    </tt>
<a name="LDAPDNCodec.__init__"></a><div id="LDAPDNCodec.__init__-def"><a name="L28"></a><tt class="py-lineno">28</tt> <a class="py-toggle" href="#" id="LDAPDNCodec.__init__-toggle" onclick="return toggle('LDAPDNCodec.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.ldap_dn.LDAPDNCodec-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LDAPDNCodec.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="LDAPDNCodec.__init__-expanded"><a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line"><tt class="py-docstring">        Instantiates the LDAP DN codec.</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">        <tt id="link-7" class="py-name"><a title="esapi.codecs.codec.Codec" class="py-name" href="#" onclick="return doclink('link-7', 'Codec', 'link-6');">Codec</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method esapi.access_reference_map.AccessReferenceMap.__init__()=esapi.access_reference_map.AccessReferenceMap-class.html#__init__,Method esapi.authenticator.Authenticator.__init__()=esapi.authenticator.Authenticator-class.html#__init__,Method esapi.codecs.codec.Codec.__init__()=esapi.codecs.codec.Codec-class.html#__init__,Method esapi.codecs.css.CSSCodec.__init__()=esapi.codecs.css.CSSCodec-class.html#__init__,Method esapi.codecs.html_entity.HTMLEntityCodec.__init__()=esapi.codecs.html_entity.HTMLEntityCodec-class.html#__init__,Method esapi.codecs.javascript.JavascriptCodec.__init__()=esapi.codecs.javascript.JavascriptCodec-class.html#__init__,Method esapi.codecs.ldap.LDAPCodec.__init__()=esapi.codecs.ldap.LDAPCodec-class.html#__init__,Method esapi.codecs.ldap_dn.LDAPDNCodec.__init__()=esapi.codecs.ldap_dn.LDAPDNCodec-class.html#__init__,Method esapi.codecs.mysql.MySQLCodec.__init__()=esapi.codecs.mysql.MySQLCodec-class.html#__init__,Method esapi.codecs.oracle.OracleCodec.__init__()=esapi.codecs.oracle.OracleCodec-class.html#__init__,Method esapi.codecs.percent.PercentCodec.__init__()=esapi.codecs.percent.PercentCodec-class.html#__init__,Method esapi.codecs.push_back_string.PushbackString.__init__()=esapi.codecs.push_back_string.PushbackString-class.html#__init__,Method esapi.codecs.unix.UnixCodec.__init__()=esapi.codecs.unix.UnixCodec-class.html#__init__,Method esapi.codecs.vbscript.VBScriptCodec.__init__()=esapi.codecs.vbscript.VBScriptCodec-class.html#__init__,Method esapi.codecs.windows.WindowsCodec.__init__()=esapi.codecs.windows.WindowsCodec-class.html#__init__,Method esapi.encoder.Encoder.__init__()=esapi.encoder.Encoder-class.html#__init__,Method esapi.encryptor.Encryptor.__init__()=esapi.encryptor.Encryptor-class.html#__init__,Method esapi.exceptions.AccessControlException.__init__()=esapi.exceptions.AccessControlException-class.html#__init__,Method esapi.exceptions.AuthenticationAccountsException.__init__()=esapi.exceptions.AuthenticationAccountsException-class.html#__init__,Method esapi.exceptions.AuthenticationCredentialsException.__init__()=esapi.exceptions.AuthenticationCredentialsException-class.html#__init__,Method esapi.exceptions.AuthenticationException.__init__()=esapi.exceptions.AuthenticationException-class.html#__init__,Method esapi.exceptions.AuthenticationHostException.__init__()=esapi.exceptions.AuthenticationHostException-class.html#__init__,Method esapi.exceptions.AuthenticationLoginException.__init__()=esapi.exceptions.AuthenticationLoginException-class.html#__init__,Method esapi.exceptions.AvailabilityException.__init__()=esapi.exceptions.AvailabilityException-class.html#__init__,Method esapi.exceptions.CertificateException.__init__()=esapi.exceptions.CertificateException-class.html#__init__,Method esapi.exceptions.ConfigurationException.__init__()=esapi.exceptions.ConfigurationException-class.html#__init__,Method esapi.exceptions.EncodingException.__init__()=esapi.exceptions.EncodingException-class.html#__init__,Method esapi.exceptions.EncryptionException.__init__()=esapi.exceptions.EncryptionException-class.html#__init__,Method esapi.exceptions.EnterpriseSecurityException.__init__()=esapi.exceptions.EnterpriseSecurityException-class.html#__init__,Method esapi.exceptions.ExecutorException.__init__()=esapi.exceptions.ExecutorException-class.html#__init__,Method esapi.exceptions.IntegrityException.__init__()=esapi.exceptions.IntegrityException-class.html#__init__,Method esapi.exceptions.IntrusionException.__init__()=esapi.exceptions.IntrusionException-class.html#__init__,Method esapi.exceptions.ValidationAvailabilityException.__init__()=esapi.exceptions.ValidationAvailabilityException-class.html#__init__,Method esapi.exceptions.ValidationException.__init__()=esapi.exceptions.ValidationException-class.html#__init__,Method esapi.exceptions.ValidationUploadException.__init__()=esapi.exceptions.ValidationUploadException-class.html#__init__,Method esapi.executor.Executor.__init__()=esapi.executor.Executor-class.html#__init__,Method esapi.http_utilities.HTTPUtilities.__init__()=esapi.http_utilities.HTTPUtilities-class.html#__init__,Method esapi.ihttp.IHttpRequest.__init__()=esapi.ihttp.IHttpRequest-class.html#__init__,Method esapi.ihttp.IHttpResponse.__init__()=esapi.ihttp.IHttpResponse-class.html#__init__,Method esapi.ihttp.ISession.__init__()=esapi.ihttp.ISession-class.html#__init__,Method esapi.log_factory.LogFactory.__init__()=esapi.log_factory.LogFactory-class.html#__init__,Method esapi.logger.Logger.EventType.__init__()=esapi.logger.Logger.EventType-class.html#__init__,Method esapi.logger.Logger.__init__()=esapi.logger.Logger-class.html#__init__,Method esapi.randomizer.Randomizer.__init__()=esapi.randomizer.Randomizer-class.html#__init__,Method esapi.reference.default_encoder.DefaultEncoder.__init__()=esapi.reference.default_encoder.DefaultEncoder-class.html#__init__,Method esapi.reference.default_encryptor.DefaultEncryptor.__init__()=esapi.reference.default_encryptor.DefaultEncryptor-class.html#__init__,Method esapi.reference.default_executor.DefaultExecutor.__init__()=esapi.reference.default_executor.DefaultExecutor-class.html#__init__,Method esapi.reference.default_http_utilities.DefaultHTTPUtilities.__init__()=esapi.reference.default_http_utilities.DefaultHTTPUtilities-class.html#__init__,Method esapi.reference.default_intrusion_detector.DefaultIntrusionDetector.Event.__init__()=esapi.reference.default_intrusion_detector.DefaultIntrusionDetector.Event-class.html#__init__,Method esapi.reference.default_intrusion_detector.DefaultIntrusionDetector.__init__()=esapi.reference.default_intrusion_detector.DefaultIntrusionDetector-class.html#__init__,Method esapi.reference.default_randomizer.DefaultRandomizer.__init__()=esapi.reference.default_randomizer.DefaultRandomizer-class.html#__init__,Method esapi.reference.default_security_configuration.DefaultSecurityConfiguration.__init__()=esapi.reference.default_security_configuration.DefaultSecurityConfiguration-class.html#__init__,Method esapi.reference.default_user.DefaultUser.__init__()=esapi.reference.default_user.DefaultUser-class.html#__init__,Method esapi.reference.default_validator.DefaultValidator.__init__()=esapi.reference.default_validator.DefaultValidator-class.html#__init__,Method esapi.reference.file_based_access_controller.FileBasedAccessController.__init__()=esapi.reference.file_based_access_controller.FileBasedAccessController-class.html#__init__,Method esapi.reference.file_based_access_controller.Rule.__init__()=esapi.reference.file_based_access_controller.Rule-class.html#__init__,Method esapi.reference.python_log_factory.PythonLogFactory.PythonLogger.__init__()=esapi.reference.python_log_factory.PythonLogFactory.PythonLogger-class.html#__init__,Method esapi.reference.python_log_factory.PythonLogFactory.__init__()=esapi.reference.python_log_factory.PythonLogFactory-class.html#__init__,Method esapi.reference.random_access_reference_map.RandomAccessReferenceMap.__init__()=esapi.reference.random_access_reference_map.RandomAccessReferenceMap-class.html#__init__,Method esapi.reference.shelve_authenticator.ShelveAuthenticator.__init__()=esapi.reference.shelve_authenticator.ShelveAuthenticator-class.html#__init__,Method esapi.reference.user_credentials.UserCredentials.__init__()=esapi.reference.user_credentials.UserCredentials-class.html#__init__,Method esapi.reference.validation.base_validation_rule.BaseValidationRule.__init__()=esapi.reference.validation.base_validation_rule.BaseValidationRule-class.html#__init__,Method esapi.reference.validation.credit_card_validation_rule.CreditCardValidationRule.__init__()=esapi.reference.validation.credit_card_validation_rule.CreditCardValidationRule-class.html#__init__,Method esapi.reference.validation.date_validation_rule.DateValidationRule.__init__()=esapi.reference.validation.date_validation_rule.DateValidationRule-class.html#__init__,Method esapi.reference.validation.number_validation_rule.NumberValidationRule.__init__()=esapi.reference.validation.number_validation_rule.NumberValidationRule-class.html#__init__,Method esapi.reference.validation.string_validation_rule.StringValidationRule.__init__()=esapi.reference.validation.string_validation_rule.StringValidationRule-class.html#__init__,Method esapi.security_configuration.SecurityConfiguration.Threshold.__init__()=esapi.security_configuration.SecurityConfiguration.Threshold-class.html#__init__,Method esapi.security_configuration.SecurityConfiguration.__init__()=esapi.security_configuration.SecurityConfiguration-class.html#__init__,Method esapi.test.http.mock_http_request.MockHttpRequest.__init__()=esapi.test.http.mock_http_request.MockHttpRequest-class.html#__init__,Method esapi.test.http.mock_http_response.MockHttpResponse.__init__()=esapi.test.http.mock_http_response.MockHttpResponse-class.html#__init__,Method esapi.test.http.mock_session.MockSession.__init__()=esapi.test.http.mock_session.MockSession-class.html#__init__,Method esapi.test.test_access_controller.AccessControllerTest.__init__()=esapi.test.test_access_controller.AccessControllerTest-class.html#__init__,Method esapi.test.test_authenticator.ValidatorTest.__init__()=esapi.test.test_authenticator.ValidatorTest-class.html#__init__,Method esapi.test.test_encoder.EncoderTest.__init__()=esapi.test.test_encoder.EncoderTest-class.html#__init__,Method esapi.test.test_encryptor.EncryptorTest.__init__()=esapi.test.test_encryptor.EncryptorTest-class.html#__init__,Method esapi.test.test_executor.ExecutorTest.__init__()=esapi.test.test_executor.ExecutorTest-class.html#__init__,Method esapi.test.test_http_utilities.HTTPUtilitiesTest.__init__()=esapi.test.test_http_utilities.HTTPUtilitiesTest-class.html#__init__,Method esapi.test.test_intrusion_detector.IntrusionDetectorTest.__init__()=esapi.test.test_intrusion_detector.IntrusionDetectorTest-class.html#__init__,Method esapi.test.test_logger.LoggerTest.__init__()=esapi.test.test_logger.LoggerTest-class.html#__init__,Method esapi.test.test_random_access_map.ARMTest.__init__()=esapi.test.test_random_access_map.ARMTest-class.html#__init__,Method esapi.test.test_randomizer.RandomizerTest.__init__()=esapi.test.test_randomizer.RandomizerTest-class.html#__init__,Method esapi.test.test_user.UserTest.__init__()=esapi.test.test_user.UserTest-class.html#__init__,Method esapi.test.test_validator.ValidatorTest.__init__()=esapi.test.test_validator.ValidatorTest-class.html#__init__,Method esapi.user.AnonymousUser.__init__()=esapi.user.AnonymousUser-class.html#__init__,Method esapi.user.User.__init__()=esapi.user.User-class.html#__init__,Method esapi.validator.Validator.__init__()=esapi.validator.Validator-class.html#__init__"><a title="esapi.access_reference_map.AccessReferenceMap.__init__
esapi.authenticator.Authenticator.__init__
esapi.codecs.codec.Codec.__init__
esapi.codecs.css.CSSCodec.__init__
esapi.codecs.html_entity.HTMLEntityCodec.__init__
esapi.codecs.javascript.JavascriptCodec.__init__
esapi.codecs.ldap.LDAPCodec.__init__
esapi.codecs.ldap_dn.LDAPDNCodec.__init__
esapi.codecs.mysql.MySQLCodec.__init__
esapi.codecs.oracle.OracleCodec.__init__
esapi.codecs.percent.PercentCodec.__init__
esapi.codecs.push_back_string.PushbackString.__init__
esapi.codecs.unix.UnixCodec.__init__
esapi.codecs.vbscript.VBScriptCodec.__init__
esapi.codecs.windows.WindowsCodec.__init__
esapi.encoder.Encoder.__init__
esapi.encryptor.Encryptor.__init__
esapi.exceptions.AccessControlException.__init__
esapi.exceptions.AuthenticationAccountsException.__init__
esapi.exceptions.AuthenticationCredentialsException.__init__
esapi.exceptions.AuthenticationException.__init__
esapi.exceptions.AuthenticationHostException.__init__
esapi.exceptions.AuthenticationLoginException.__init__
esapi.exceptions.AvailabilityException.__init__
esapi.exceptions.CertificateException.__init__
esapi.exceptions.ConfigurationException.__init__
esapi.exceptions.EncodingException.__init__
esapi.exceptions.EncryptionException.__init__
esapi.exceptions.EnterpriseSecurityException.__init__
esapi.exceptions.ExecutorException.__init__
esapi.exceptions.IntegrityException.__init__
esapi.exceptions.IntrusionException.__init__
esapi.exceptions.ValidationAvailabilityException.__init__
esapi.exceptions.ValidationException.__init__
esapi.exceptions.ValidationUploadException.__init__
esapi.executor.Executor.__init__
esapi.http_utilities.HTTPUtilities.__init__
esapi.ihttp.IHttpRequest.__init__
esapi.ihttp.IHttpResponse.__init__
esapi.ihttp.ISession.__init__
esapi.log_factory.LogFactory.__init__
esapi.logger.Logger.EventType.__init__
esapi.logger.Logger.__init__
esapi.randomizer.Randomizer.__init__
esapi.reference.default_encoder.DefaultEncoder.__init__
esapi.reference.default_encryptor.DefaultEncryptor.__init__
esapi.reference.default_executor.DefaultExecutor.__init__
esapi.reference.default_http_utilities.DefaultHTTPUtilities.__init__
esapi.reference.default_intrusion_detector.DefaultIntrusionDetector.Event.__init__
esapi.reference.default_intrusion_detector.DefaultIntrusionDetector.__init__
esapi.reference.default_randomizer.DefaultRandomizer.__init__
esapi.reference.default_security_configuration.DefaultSecurityConfiguration.__init__
esapi.reference.default_user.DefaultUser.__init__
esapi.reference.default_validator.DefaultValidator.__init__
esapi.reference.file_based_access_controller.FileBasedAccessController.__init__
esapi.reference.file_based_access_controller.Rule.__init__
esapi.reference.python_log_factory.PythonLogFactory.PythonLogger.__init__
esapi.reference.python_log_factory.PythonLogFactory.__init__
esapi.reference.random_access_reference_map.RandomAccessReferenceMap.__init__
esapi.reference.shelve_authenticator.ShelveAuthenticator.__init__
esapi.reference.user_credentials.UserCredentials.__init__
esapi.reference.validation.base_validation_rule.BaseValidationRule.__init__
esapi.reference.validation.credit_card_validation_rule.CreditCardValidationRule.__init__
esapi.reference.validation.date_validation_rule.DateValidationRule.__init__
esapi.reference.validation.number_validation_rule.NumberValidationRule.__init__
esapi.reference.validation.string_validation_rule.StringValidationRule.__init__
esapi.security_configuration.SecurityConfiguration.Threshold.__init__
esapi.security_configuration.SecurityConfiguration.__init__
esapi.test.http.mock_http_request.MockHttpRequest.__init__
esapi.test.http.mock_http_response.MockHttpResponse.__init__
esapi.test.http.mock_session.MockSession.__init__
esapi.test.test_access_controller.AccessControllerTest.__init__
esapi.test.test_authenticator.ValidatorTest.__init__
esapi.test.test_encoder.EncoderTest.__init__
esapi.test.test_encryptor.EncryptorTest.__init__
esapi.test.test_executor.ExecutorTest.__init__
esapi.test.test_http_utilities.HTTPUtilitiesTest.__init__
esapi.test.test_intrusion_detector.IntrusionDetectorTest.__init__
esapi.test.test_logger.LoggerTest.__init__
esapi.test.test_random_access_map.ARMTest.__init__
esapi.test.test_randomizer.RandomizerTest.__init__
esapi.test.test_user.UserTest.__init__
esapi.test.test_validator.ValidatorTest.__init__
esapi.user.AnonymousUser.__init__
esapi.user.User.__init__
esapi.validator.Validator.__init__" class="py-name" href="#" onclick="return doclink('link-8', '__init__', 'link-8');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">         </tt>
<a name="LDAPDNCodec.encode"></a><div id="LDAPDNCodec.encode-def"><a name="L34"></a><tt class="py-lineno">34</tt> <a class="py-toggle" href="#" id="LDAPDNCodec.encode-toggle" onclick="return toggle('LDAPDNCodec.encode');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.ldap_dn.LDAPDNCodec-class.html#encode">encode</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">immune</tt><tt class="py-op">,</tt> <tt class="py-param">raw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LDAPDNCodec.encode-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="LDAPDNCodec.encode-expanded"><a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line"><tt class="py-docstring">        Encode a String so that it can be safely used in an LDAP distinguished</tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line"><tt class="py-docstring">        name.</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt>     </tt>
<a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line">        <tt class="py-name">ret</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">            <tt class="py-comment"># Add the leading backslash if needed</tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt>  <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">raw</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">raw</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">' '</tt> <tt class="py-keyword">or</tt> <tt class="py-name">raw</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'#'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line">                <tt class="py-name">ret</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\\'</tt> </tt>
<a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line">                 </tt>
<a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">                <tt class="py-keyword">for</tt> <tt class="py-name">char</tt> <tt class="py-keyword">in</tt> <tt class="py-name">raw</tt><tt class="py-op">:</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">                    <tt class="py-name">ret</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method esapi.codecs.codec.Codec.encode_character()=esapi.codecs.codec.Codec-class.html#encode_character,Method esapi.codecs.css.CSSCodec.encode_character()=esapi.codecs.css.CSSCodec-class.html#encode_character,Method esapi.codecs.html_entity.HTMLEntityCodec.encode_character()=esapi.codecs.html_entity.HTMLEntityCodec-class.html#encode_character,Method esapi.codecs.javascript.JavascriptCodec.encode_character()=esapi.codecs.javascript.JavascriptCodec-class.html#encode_character,Method esapi.codecs.ldap.LDAPCodec.encode_character()=esapi.codecs.ldap.LDAPCodec-class.html#encode_character,Method esapi.codecs.ldap_dn.LDAPDNCodec.encode_character()=esapi.codecs.ldap_dn.LDAPDNCodec-class.html#encode_character,Method esapi.codecs.mysql.MySQLCodec.encode_character()=esapi.codecs.mysql.MySQLCodec-class.html#encode_character,Method esapi.codecs.oracle.OracleCodec.encode_character()=esapi.codecs.oracle.OracleCodec-class.html#encode_character,Method esapi.codecs.percent.PercentCodec.encode_character()=esapi.codecs.percent.PercentCodec-class.html#encode_character,Method esapi.codecs.unix.UnixCodec.encode_character()=esapi.codecs.unix.UnixCodec-class.html#encode_character,Method esapi.codecs.vbscript.VBScriptCodec.encode_character()=esapi.codecs.vbscript.VBScriptCodec-class.html#encode_character,Method esapi.codecs.windows.WindowsCodec.encode_character()=esapi.codecs.windows.WindowsCodec-class.html#encode_character"><a title="esapi.codecs.codec.Codec.encode_character
esapi.codecs.css.CSSCodec.encode_character
esapi.codecs.html_entity.HTMLEntityCodec.encode_character
esapi.codecs.javascript.JavascriptCodec.encode_character
esapi.codecs.ldap.LDAPCodec.encode_character
esapi.codecs.ldap_dn.LDAPDNCodec.encode_character
esapi.codecs.mysql.MySQLCodec.encode_character
esapi.codecs.oracle.OracleCodec.encode_character
esapi.codecs.percent.PercentCodec.encode_character
esapi.codecs.unix.UnixCodec.encode_character
esapi.codecs.vbscript.VBScriptCodec.encode_character
esapi.codecs.windows.WindowsCodec.encode_character" class="py-name" href="#" onclick="return doclink('link-9', 'encode_character', 'link-9');">encode_character</a></tt><tt class="py-op">(</tt><tt class="py-name">immune</tt><tt class="py-op">,</tt> <tt class="py-name">char</tt><tt class="py-op">)</tt> </tt>
<a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">TypeError</tt><tt class="py-op">:</tt> </tt>
<a name="L49"></a><tt class="py-lineno">49</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L50"></a><tt class="py-lineno">50</tt>  <tt class="py-line">                 </tt>
<a name="L51"></a><tt class="py-lineno">51</tt>  <tt class="py-line">            <tt class="py-comment"># Add the trailing backslash if needed</tt> </tt>
<a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">raw</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">1</tt> <tt class="py-keyword">and</tt> <tt class="py-name">raw</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">' '</tt><tt class="py-op">:</tt> </tt>
<a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line">                <tt class="py-name">ret</tt> <tt class="py-op">=</tt> <tt class="py-name">ret</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">"\\"</tt> <tt class="py-op">+</tt> <tt class="py-name">ret</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L54"></a><tt class="py-lineno">54</tt>  <tt class="py-line">                 </tt>
<a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">ret</tt> </tt>
<a name="L56"></a><tt class="py-lineno">56</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">TypeError</tt><tt class="py-op">:</tt> </tt>
<a name="L57"></a><tt class="py-lineno">57</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L58"></a><tt class="py-lineno">58</tt>  <tt class="py-line">     </tt>
<a name="LDAPDNCodec.encode_character"></a><div id="LDAPDNCodec.encode_character-def"><a name="L59"></a><tt class="py-lineno">59</tt> <a class="py-toggle" href="#" id="LDAPDNCodec.encode_character-toggle" onclick="return toggle('LDAPDNCodec.encode_character');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.ldap_dn.LDAPDNCodec-class.html#encode_character">encode_character</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">immune</tt><tt class="py-op">,</tt> <tt class="py-param">char</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LDAPDNCodec.encode_character-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="LDAPDNCodec.encode_character-expanded"><a name="L60"></a><tt class="py-lineno">60</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L61"></a><tt class="py-lineno">61</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L62"></a><tt class="py-lineno">62</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L63"></a><tt class="py-lineno">63</tt>  <tt class="py-line">        <tt class="py-comment"># Check for immunes</tt> </tt>
<a name="L64"></a><tt class="py-lineno">64</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">char</tt> <tt class="py-keyword">in</tt> <tt class="py-name">immune</tt><tt class="py-op">:</tt> </tt>
<a name="L65"></a><tt class="py-lineno">65</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">char</tt> </tt>
<a name="L66"></a><tt class="py-lineno">66</tt>  <tt class="py-line">             </tt>
<a name="L67"></a><tt class="py-lineno">67</tt>  <tt class="py-line">        <tt class="py-name">replacement</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L68"></a><tt class="py-lineno">68</tt>  <tt class="py-line">            <tt class="py-string">'\\'</tt> <tt class="py-op">:</tt> <tt class="py-string">'\\\\'</tt><tt class="py-op">,</tt> </tt>
<a name="L69"></a><tt class="py-lineno">69</tt>  <tt class="py-line">            <tt class="py-string">','</tt>  <tt class="py-op">:</tt> <tt class="py-string">'\\,'</tt><tt class="py-op">,</tt> </tt>
<a name="L70"></a><tt class="py-lineno">70</tt>  <tt class="py-line">            <tt class="py-string">'+'</tt>  <tt class="py-op">:</tt> <tt class="py-string">'\\+'</tt><tt class="py-op">,</tt> </tt>
<a name="L71"></a><tt class="py-lineno">71</tt>  <tt class="py-line">            <tt class="py-string">'"'</tt>  <tt class="py-op">:</tt> <tt class="py-string">'\\"'</tt><tt class="py-op">,</tt> </tt>
<a name="L72"></a><tt class="py-lineno">72</tt>  <tt class="py-line">            <tt class="py-string">'&lt;'</tt>  <tt class="py-op">:</tt> <tt class="py-string">'\\&lt;'</tt><tt class="py-op">,</tt> </tt>
<a name="L73"></a><tt class="py-lineno">73</tt>  <tt class="py-line">            <tt class="py-string">'&gt;'</tt>  <tt class="py-op">:</tt> <tt class="py-string">'\\&gt;'</tt><tt class="py-op">,</tt> </tt>
<a name="L74"></a><tt class="py-lineno">74</tt>  <tt class="py-line">            <tt class="py-string">';'</tt>  <tt class="py-op">:</tt> <tt class="py-string">'\\;'</tt><tt class="py-op">,</tt> </tt>
<a name="L75"></a><tt class="py-lineno">75</tt>  <tt class="py-line">            <tt class="py-op">}</tt> </tt>
<a name="L76"></a><tt class="py-lineno">76</tt>  <tt class="py-line">             </tt>
<a name="L77"></a><tt class="py-lineno">77</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">replacement</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">char</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L78"></a><tt class="py-lineno">78</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">replacement</tt><tt class="py-op">[</tt><tt class="py-name">char</tt><tt class="py-op">]</tt> </tt>
<a name="L79"></a><tt class="py-lineno">79</tt>  <tt class="py-line">             </tt>
<a name="L80"></a><tt class="py-lineno">80</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">char</tt> </tt>
</div><a name="L81"></a><tt class="py-lineno">81</tt>  <tt class="py-line">         </tt>
<a name="LDAPDNCodec.decode"></a><div id="LDAPDNCodec.decode-def"><a name="L82"></a><tt class="py-lineno">82</tt> <a class="py-toggle" href="#" id="LDAPDNCodec.decode-toggle" onclick="return toggle('LDAPDNCodec.decode');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.ldap_dn.LDAPDNCodec-class.html#decode">decode</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">encoded</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LDAPDNCodec.decode-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="LDAPDNCodec.decode-expanded"><a name="L83"></a><tt class="py-lineno">83</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L84"></a><tt class="py-lineno">84</tt>  <tt class="py-line">     </tt>
<a name="LDAPDNCodec.decode_character"></a><div id="LDAPDNCodec.decode_character-def"><a name="L85"></a><tt class="py-lineno">85</tt> <a class="py-toggle" href="#" id="LDAPDNCodec.decode_character-toggle" onclick="return toggle('LDAPDNCodec.decode_character');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.ldap_dn.LDAPDNCodec-class.html#decode_character">decode_character</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pbs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="LDAPDNCodec.decode_character-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="LDAPDNCodec.decode_character-expanded"><a name="L86"></a><tt class="py-lineno">86</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L87"></a><tt class="py-lineno">87</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="esapi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Nov  8 16:04:23 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
